Retrieve Widgets from a Specific Dashboard

GET 
https://ServerIP:PortNumber/api/v1/visualization/dashboards/:id

This endpoint retrieves all widgets associated with a specific dashboard, identified by its unique dashboard ID. The response includes the widget IDs and details of each widget within the dashboard, allowing for subsequent metric retrieval operations on individual widgets.

Request

Path Parameters

id integerrequired

The unique ID of the dashboard for which the widgets need to be retrieved.

Responses

200

Successfully retrieved the list of widgets for the specified dashboard

application/json

Schema

Schema

oneOf
Dashboard_Get_By_ID_Response
response-code integer
status string
result object[]
Array [
dashboard.name string
dashboard.category string
dashboard.access.type string
dashboard.users integer[]
dashboard.context object
dashboard.widgets object[]
Array [
id integer
x integer
y integer
h integer
w integer
]
id integer
]
Dashboard_Get_By_ID_Response
response-code integer
status string
result object[]
Array [
dashboard.name string
dashboard.category string
dashboard.access.type string
dashboard.users integer[]
dashboard.context object
dashboard.widgets object[]
Array [
id integer
x integer
y integer
h integer
w integer
]
id integer
]

Example (from schema)

{}

400

Invalid dashboard ID provided. Please check the ID and try again

application/json

Schema

Schema

response-code integer
status string
message string
error.code string

Example (from schema)

{
  "response-code": 400,
  "status": "fail",
  "message": "Bad request",
  "error.code": "MD031"
}

403

Access to the specified dashboard is forbidden. The user might not have the necessary permissions.

application/json

Schema

Schema

response-code integer
message string
error.code string

Example (from schema)

{
  "response-code": 403,
  "message": "Unauthorized access: Client is not allowed to access API",
  "error.code": "MD022"
}

500

An internal server error occurred while retrieving the widgets for the specified dashboard.

application/json

Schema

Schema

result object[]
Array [
response-code integer
status string
message string
error.code string
error string
]

Example (from schema)

{
  "result": [
    {
      "response-code": 500,
      "status": "fail",
      "message": "Internal server exception, Possible reason: Cannot invoke \"String.length()\" because \"content\" is null",
      "error.code": "MD031",
      "error": "io.vertx.core.json.jackson.DatabindCodec.createParser(DatabindCodec.java:116)\n\tat io.vertx.core.json.jackson.DatabindCodec.fromString(DatabindCodec.java:90)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:83)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:95)\n\tat"
    }
  ]
}

Authorization: cookie

name: cookietype: apiKeyin: cookie

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://ServerIP:PortNumber/api/v1/visualization/dashboards/:id' \
-H 'Accept: application/json'

Request Collapse all

Base URL

https://ServerIP:PortNumber/api/v1

Auth

Security Scheme

CookieAuthBearerAuth

CookieAuth

Parameters

id — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!